<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
Zapatec.Widget
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="Zapatec.Widget";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="../overview-summary-zpwidget.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">&nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Zapatec Utils</B>
</EM>
</TD
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../Zapatec/Utils/Sizable.html"><B>PREV CLASS</B></A><!-- 
   NEXT CLASS 
-->
&nbsp;<A HREF="../Zapatec/Wizard.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>

<!-- ======== START OF CLASS DATA ======== -->
<H2>Class Zapatec.Widget</H2>
<PRE>Object
   |
   +--<a href='../Zapatec/EventDriven.html'>Zapatec.EventDriven</a>
         |
         +--<b>Zapatec.Widget</b>
</PRE>

   
      <DL>
      <DT>
         <B>Direct Known Subclasses:</B> 
         <DD>
                  <a href='../Zapatec/ColorPicker.html'>Zapatec.ColorPicker</a>, <a href='../Zapatec/DemoExplorer.html'>Zapatec.DemoExplorer</a>, <a href='../Zapatec/ChildWidget.html'>Zapatec.ChildWidget</a>, <a href='../Zapatec/EditInline.html'>Zapatec.EditInline</a>, <a href='../Zapatec/Spinner.html'>Zapatec.Spinner</a>, <a href='../Zapatec/ProgressBar.html'>Zapatec.ProgressBar</a>
         </DD>
      </DL>
   


<HR>
<DL>
   <!-- Class definition -->
   <DT>class 
   <B>Zapatec.Widget</B>
   
      <DT>extends <a href='../Zapatec/EventDriven.html'>Zapatec.EventDriven</a> 
   

</DL>
   
   <P>
   <I>Defined in <a href='../overview-summary-zpwidget.js.html'>zpwidget.js</a></I><BR/><BR/>
   </P>
   
   <HR>

<!-- ======== NESTED CLASS SUMMARY ======== -->

<!-- ======== END NESTED CLASS SUMMARY ======== -->


<!-- =========== FIELD SUMMARY =========== -->

   <A NAME="field_summary"><!-- --></A>
      <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
         <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
            <TD COLSPAN=2><FONT SIZE="+2">
               <B>Field Summary</B></FONT></TD>
         </TR>

   <!-- This is one instance field summary -->
   
   <TR BGCOLOR="white" CLASS="TableRowColor">
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
   <CODE>&nbsp;Object</CODE></FONT></TD>
   <TD><CODE><B><A HREF="#arg">arg</A></B></CODE>
   <BR>
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
   </TR>
   
   <TR BGCOLOR="white" CLASS="TableRowColor">
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
   <CODE>&nbsp;Object</CODE></FONT></TD>
   <TD><CODE><B><A HREF="#config">config</A></B></CODE>
   <BR>
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
   </TR>
   

   </TABLE>
   &nbsp;
   

   

<!-- =========== END FIELD SUMMARY =========== -->


<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
   <TD>
      <CODE>
	 <B>
	    <A HREF="#Zapatec.Widget()">Zapatec.Widget</A></B>(&lt;object&gt; oArg)
      </CODE>
      <BR>
      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      Base widget class.
      </TD>
</TR>
</TABLE>

<!-- ======== END CONSTRUCTOR SUMMARY ======== -->

&nbsp;

<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>


   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#acceptData">acceptData</A></B>(&lt;object&gt; oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Receives data back from other widget previously passed to it using its
 <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a> method.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#addCircularRef">addCircularRef</A></B>(&lt;object&gt; oElement, &lt;string&gt; sProperty)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Saves a property that must be set to null on window unload event.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#addEventHandler">addEventHandler</A></B>(&lt;string&gt; sHandlerName, &lt;object&gt; oElement, &lt;string&gt; sEvent, &lt;function&gt; fListener, &lt;boolean&gt; bUseCapture, &lt;boolean&gt; bRemoveOnUnload)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Adds new DOM event.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#addStandardEventListeners">addStandardEventListeners</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Adds standard event listeners.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#addUserEventListeners">addUserEventListeners</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Adds custom event listeners.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#configure">configure</A></B>(&lt;object&gt; oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Configures widget.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#createProperty">createProperty</A></B>(&lt;object&gt; oElement, &lt;string&gt; sProperty, &lt;any&gt; val)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Assigns a value to a custom property of DOM object.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#defineConfigOption">defineConfigOption</A></B>(&lt;string&gt; sOption, &lt;any&gt; val)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Defines config option if it is not defined yet.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#discard">discard</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Deletes event handlers, control widgets, templates and references to the
 object to let JavaScript garbage collector to delete the object.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#discardControls">discardControls</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Deletes widgets created in <a href="../Zapatec/Widget.html#initControls">Zapatec.Widget.initControls()</a>.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#discardEventHandlers">discardEventHandlers</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Deletes event handlers set in <a href="../Zapatec/Widget.html#setEventHandlers">Zapatec.Widget.setEventHandlers()</a>.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#discardTemplates">discardTemplates</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Deletes templates created in <a href="../Zapatec/Widget.html#initTemplates">Zapatec.Widget.initTemplates()</a>.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#display">display</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Must compile main template and display result.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;string</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#formElementId">formElementId</A></B>(oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Forms unique element id from widget id, unique counter and provided prefix
 and suffix.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;string</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#getClassName">getClassName</A></B>(oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Forms class name from theme name and provided prefix and suffix.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;object</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#getConfiguration">getConfiguration</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Returns current configuration of the widget.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;Object</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#getMessage">getMessage</A></B>(key)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Get message for given key, make substitutions and return.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;Object</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#hideContainer">hideContainer</A></B>(&lt;object&gt; effects, &lt;number&gt; animSpeed, onFinish)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Hides widget using given effects and animation speed.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#init">init</A></B>(&lt;object&gt; oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Initializes object.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#initControls">initControls</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Must initialize control widgets.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#initTemplates">initTemplates</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Initializes templates.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadData">loadData</A></B>(&lt;object&gt; oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads data from the specified source.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadDataAbort">loadDataAbort</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Aborts data load from server.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadDataHtml">loadDataHtml</A></B>(&lt;object&gt; oSource)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads data from the HTML source.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadDataHtmlText">loadDataHtmlText</A></B>(&lt;string&gt; sSource)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads data from the HTML fragment source.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadDataJson">loadDataJson</A></B>(&lt;object&gt; oSource)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads data from the JSON source.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadDataXml">loadDataXml</A></B>(&lt;object&gt; oSource)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads data from the XML source.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadTemplate">loadTemplate</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads specified template file.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#loadTheme">loadTheme</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads specified theme.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#receiveData">receiveData</A></B>(&lt;object&gt; oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Loads data passed from other widget for example to view or edit them.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#reconfigure">reconfigure</A></B>(&lt;object&gt; oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Reconfigures the widget with new config options after it was initialized.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#removeEventHandler">removeEventHandler</A></B>(&lt;string&gt; sHandlerName)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Removes existing DOM event.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;any</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#replyData">replyData</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Prepares processed data to return them back to the sender in the same format
 as they were received in <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a>.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#replyDataCancel">replyDataCancel</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Cancels processing of the data received from the sender in
 <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a>.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#replyDataReturn">replyDataReturn</A></B>(&lt;object&gt; oArg)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Returns processed data back to the specified widget (not necessarily to the
 same widget from which they were received in
 <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a>).
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#reset">reset</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Reconfigures the widget with original config options.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#setEventHandlers">setEventHandlers</A></B>()
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Must set event handlers.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;Object</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#showContainer">showContainer</A></B>(&lt;object&gt; effects, &lt;number&gt; animSpeed, &lt;function&gt; onFinish)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Shows widget using given effects and animation speed.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&nbsp;Object</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#showHideContainer">showHideContainer</A></B>(&lt;object&gt; effects, &lt;number&gt; animSpeed, onFinish, &lt;boolean&gt; show)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Show/hides widget using given effects and animation speed.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&lt;static&gt;&nbsp;any</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#!s!callMethod">callMethod</A></B>(&lt;number&gt; iWidgetId, &lt;string&gt; sMethod)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Finds a widget by id and calls specified method with specified arguments and
 returns value from that method.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&lt;static&gt;&nbsp;void</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#!s!debug">debug</A></B>(&lt;string&gt; sMsg, &lt;string&gt; sType)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Displays debug information.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&lt;static&gt;&nbsp;object</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#!s!getElementById">getElementById</A></B>(&lt;string&gt; element)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Converts element id to reference.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&lt;static&gt;&nbsp;string</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#!s!getStyle">getStyle</A></B>(&lt;object&gt; element)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Returns style attribute of the specified element.
      </TD>
   </TR>

   <TR BGCOLOR="white" CLASS="TableRowColor">
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
	 <FONT SIZE="-1">
	    <CODE>&lt;static&gt;&nbsp;object</CODE>
	 </FONT>
      </TD>
      <TD>
	 <CODE>
	    <B>
	       <A HREF="#!s!getWidgetById">getWidgetById</A></B>(iId)
	 </CODE>
	 <BR>
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
	 Finds a widget by id.
      </TD>
   </TR>


</TABLE>



&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class <a href="../Zapatec/EventDriven.html">Zapatec.EventDriven</a></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>
<!-- Inherited methods -->
<a href='../Zapatec/EventDriven.html#addEventListener'>addEventListener</a>, <a href='../Zapatec/EventDriven.html#addOnetimeEventListener'>addOnetimeEventListener</a>, <a href='../Zapatec/EventDriven.html#unshiftEventListener'>unshiftEventListener</a>, <a href='../Zapatec/EventDriven.html#removeEventListener'>removeEventListener</a>, <a href='../Zapatec/EventDriven.html#removeOnetimeEventListeners'>removeOnetimeEventListeners</a>, <a href='../Zapatec/EventDriven.html#getEventListeners'>getEventListeners</a>, <a href='../Zapatec/EventDriven.html#isEventListener'>isEventListener</a>, <a href='../Zapatec/EventDriven.html#isEvent'>isEvent</a>, <a href='../Zapatec/EventDriven.html#removeEvent'>removeEvent</a>, <a href='../Zapatec/EventDriven.html#fireEvent'>fireEvent</a>
</CODE></TD>
</TR>
</TABLE>
&nbsp;

<P>
<!-- ========== END METHOD SUMMARY =========== -->


<!-- ============ FIELD DETAIL START =========== -->

   <A NAME="field_detail"><!-- --></A>
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
      <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
         <TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
      </TR>
   </TABLE>

   
   <A NAME="arg"><!-- --></A>
   <H3>arg</H3>
   <PRE>Object&nbsp;<B>arg</B></PRE>
   <UL>
   
   
   </UL>
   <HR>
   
   <A NAME="config"><!-- --></A>
   <H3>config</H3>
   <PRE>Object&nbsp;<B>config</B></PRE>
   <UL>
   
   
   </UL>
   <HR>
   


<!-- ============ FIELD DETAIL END =========== -->

    <!-- ========= CONSTRUCTOR DETAIL START ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
      <TD COLSPAN=1>
      <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
      </TD>
   </TR>
</TABLE>

<A NAME="Zapatec.Widget()"><!-- --></A><H3>
Zapatec.Widget</H3>
<PRE><B>Zapatec.Widget</B>(&lt;object&gt; oArg)</PRE>


<UL>
   Base widget class.

 <pre>
 Defines following config options:

 <b>theme</b> [string] URL of theme file, absolute or relative to the widget's
 js file. Default: "../themes/default.css". File extension must be "css".

 Alternatively may contain only theme name. Example: "default". In this case
 URL of the file will be formed automatically from the theme name and value of
 the <b>themePath</b> config option.

 Special theme "auto" is used to detect theme automatically depending from OS.
 It is replaced automatically with one of the following values:

 <i>winvista</i> for Windows Vista
 <i>winxp</i> for Windows XP
 <i>win2k</i> for other Windows
 <i>macosx</i> for Mac OSX
 <i>default</i> for other OS

 Make sure all these themes exist before using "auto" theme for the widget.

 <b>themePath</b> [string] URL of the themes directory, absolute or relative
 to the widget's js file. Default: "../themes/". Trailing slash is mandatory.
 Path specified in the <b>theme</b> config option overwrites this config
 option. Use only if you pass theme name instead of the URL in the
 <b>theme</b> config option.

 <b>asyncTheme</b> [boolean] Load theme asynchronously. This means that script
 execution will not be suspended until theme is loaded. Theme will be applied
 once it is loaded. Default: false.

 <b>templateFile</b> [string] URL of template file, absolute or relative to
 the widget's js file. Default: "../templates/default.html". File extension
 must be "html".

 Alternatively may contain only template name. Example: "default". In this
 case URL of the file will be formed automatically from the template name and
 value of the <b>templatePath</b> config option.

 Template file is supposed to contain a set of templates used in the widget.
 Each template must be enclosed in &lt;textarea&gt; tag having ID, which is
 used as template name in <b>templates</b> config option. Each
 &lt;textarea&gt; tag must have style attribute with "display: hidden".
 Example:
 &lt;textarea id="zpWidgetTemplateMain" style="display: none"&gt;
   Template HTML Source
 &lt;/textarea&gt;
 Each template is HTML source passed to new Zapatec.Template.
 See <a href="../Zapatec/Widget.html#loadTemplate">Zapatec.Widget.loadTemplate()</a>

 <b>templateFilePath</b> [string] URL of the templates directory, absolute or
 relative to the widget's js file. Default: "../templates/". Trailing slash is
 mandatory. Path specified in the <b>template</b> config option overwrites
 this config option. Use only if you pass template name instead of the URL in
 the <b>templateFile</b> config option.

 <b>templates</b> [object] associates template IDs from template file with
 template names. Specific to each widget. Example:
 {
   "main": "zpWidgetTemplateMain",
   ...
 }
 Where "main" is template name and "zpWidgetTemplateMain" is template ID in
 the templates file.

 Templates are initialized (see <a href="../Zapatec/Widget.html#initTemplates">Zapatec.Widget.initTemplates()</a>) and then
 each template (Zapatec.Template) object can be accessed using its name.
 Example: this.templates.main is reference to Zapatec.Template object, which
 was initialized with HTML source taken from "zpWidgetTemplateMain" textarea.

 <b>source</b> Depends on "sourceType" option. Possible sources:
 -----------------------------------------------------------------------------
 sourceType     | source
 ---------------|-------------------------------------------------------------
 1) 'html'      | [object or string] HTMLElement or its id.
 2) 'html/text' | [string] HTML fragment.
 3) 'html/url'  | [string] URL of HTML fragment.
 4) 'json'      | [object or string] JSON object or string (http://json.org).
 5) 'json/url'  | [string] URL of JSON data source.
 6) 'xml'       | [object or string] XMLDocument object or XML string.
 7) 'xml/url'   | [string] URL of XML data source.
 -----------------------------------------------------------------------------

 <b>sourceType</b> [string] Used together with "source" option to specify how
 source should be processed. Possible source types:
 'html', 'html/text', 'html/url', 'json', 'json/url', 'xml', 'xml/url'.
 Default: 'html'.
 JSON format is described at http://www.json.org.

 <b>sourceFetchMethod</b> [string] Source fetch method 'GET' or 'POST'.
 Default: 'GET'.

 <b>sourceFetchContentType</b> [string] Content type when "sourceFetchMethod"
 is 'POST'.

 <b>sourceFetchContent</b> [string or object] postable string or DOM object
 data when "sourceFetchMethod" is 'POST'.

 <b>callbackSource</b> [function] May be used instead of "source",
 "sourceType" and "sourceFetchMethod" config options to get source depending
 on passed arguments. Called in scope of the widget. Receives object with
 passed arguments. Must return following object:
 {
   source: [object or string] see table above for possible sources,
   sourceType: [string] see table above for possible source types,
   method: [string, optional] method ('GET' or 'POST'),
   contentType: [string, optional] content type when using POST,
   content: [string or object, optional] postable string or DOM object data
    when using POST
 }

 <b>asyncSource</b> [boolean] Load source asynchronously. This means that
 script execution will not be suspended until source is loaded. Source will be
 processed once it is loaded. Default: true.

 <b>reliableSource</b> [boolean] Used together with "json" or "json/url"
 sourceType to skip JSON format verification. It saves a lot of time for large
 data sets. Default: true.

 <b>callbackConvertSource</b> [function] May be used to convert input data
 passed with "source" config option from custom format into internal format of
 the widget. Must return converted source.

 <b>eventListeners</b> [object] Associative array with event listeners:
 {
   [string] event name: [function or object] event listener or array of event
    listeners,
   ...
 }

 Defines internal property <b>config</b>.
 </pre>
</UL>



   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  User configuration
     </UL>
   
   
   </UL>


<!-- Constructor return value(s) -->

<!-- End constructor return value(s) -->

<!-- ADDITIONAL ATTRIBUTES -->

<HR/>
<!-- END ADDITIONAL ATTRIBUTES  -->

<!-- ========= CONSTRUCTOR DETAIL END ======== -->


<!-- ============ METHOD DETAIL START ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
      <TD COLSPAN=1><FONT SIZE="+2">
         <B>Method Detail</B></FONT>
      </TD>
   </TR>
</TABLE>

<!-- One single method detail entry -->

   <A NAME="acceptData"><!-- --></A>
   <H3>acceptData</H3>
   <PRE>void <B>acceptData</B>(&lt;object&gt; oArg)</PRE>
   
      <UL>Receives data back from other widget previously passed to it using its
 <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a> method. Extend this in child class.

 <pre>
 Argument object format:
 {
   widget: [object] Caller widget instance,
   data: [any] Data in format specific for each widget
 }

 Fires event:
 <ul>
 <li><i>acceptData</i>. Listener receives argument object passed to this
 method.</li>
 </ul>
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  Argument object    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="addCircularRef"><!-- --></A>
   <H3>addCircularRef</H3>
   <PRE>void <B>addCircularRef</B>(&lt;object&gt; oElement, &lt;string&gt; sProperty)</PRE>
   
      <UL>Saves a property that must be set to null on window unload event. Should be
 used for properties that can't be deleted by garbage collector in IE 6 due to
 circular references.

 <pre>
 Defines internal property <b>widgetCircularRefs</b>.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oElement</CODE> -  DOM object  
      </UL> 
   
     <UL><CODE>sProperty</CODE> -  Property name    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="addEventHandler"><!-- --></A>
   <H3>addEventHandler</H3>
   <PRE>void <B>addEventHandler</B>(&lt;string&gt; sHandlerName, &lt;object&gt; oElement, &lt;string&gt; sEvent, &lt;function&gt; fListener, &lt;boolean&gt; bUseCapture, &lt;boolean&gt; bRemoveOnUnload)</PRE>
   
      <UL>Adds new DOM event. Stores reference to event to internal array to remove it
 on widget discard.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>sHandlerName</CODE> -  Unique handler name  
      </UL> 
   
     <UL><CODE>oElement</CODE> -  Element object  
      </UL> 
   
     <UL><CODE>sEvent</CODE> -  Event name  
      </UL> 
   
     <UL><CODE>fListener</CODE> -  Event listener  
      </UL> 
   
     <UL><CODE>bUseCapture</CODE> -  Optional. Default: false. For details see 	http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-EventTarget-addEventListener  
      </UL> 
   
     <UL><CODE>bRemoveOnUnload</CODE> -  Optional. Default: true. remove eventlistener 	on page unload.    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="addStandardEventListeners"><!-- --></A>
   <H3>addStandardEventListeners</H3>
   <PRE>void <B>addStandardEventListeners</B>()</PRE>
   
      <UL>Adds standard event listeners.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="addUserEventListeners"><!-- --></A>
   <H3>addUserEventListeners</H3>
   <PRE>void <B>addUserEventListeners</B>()</PRE>
   
      <UL>Adds custom event listeners.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="configure"><!-- --></A>
   <H3>configure</H3>
   <PRE>void <B>configure</B>(&lt;object&gt; oArg)</PRE>
   
      <UL>Configures widget.

 <pre>
 After processing of argument, tries to get <b>Zapatec.Config</b> cookie,
 parses it and overwrites config options with respective values from result
 object. This can be useful if some widget provides means to configure it by
 end user.

 If Zapatec.Config cookie exists, it is supposed to be following JSON string:
 {
   "Zapatec.Widget": {
     "configOptionName": "configOptionValue",
     ...
   },
   ...
 }
 Where "Zapatec.Widget" is a widget class name.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  User configuration    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="createProperty"><!-- --></A>
   <H3>createProperty</H3>
   <PRE>void <B>createProperty</B>(&lt;object&gt; oElement, &lt;string&gt; sProperty, &lt;any&gt; val)</PRE>
   
      <UL>Assigns a value to a custom property of DOM object. This property will be
 set to null on window unload event. Use this function to create properties
 that can't be deleted by garbage collector in IE 6 due to circular
 references.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oElement</CODE> -  DOM object  
      </UL> 
   
     <UL><CODE>sProperty</CODE> -  Property name  
      </UL> 
   
     <UL><CODE>val</CODE> -  Property value    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="defineConfigOption"><!-- --></A>
   <H3>defineConfigOption</H3>
   <PRE>void <B>defineConfigOption</B>(&lt;string&gt; sOption, &lt;any&gt; val)</PRE>
   
      <UL>Defines config option if it is not defined yet. Sets default value of new
 config option. If default value is not specified, it is set to null.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>sOption</CODE> -  Config option name  
      </UL> 
   
     <UL><CODE>val</CODE> -  Optional. Config option default value    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="discard"><!-- --></A>
   <H3>discard</H3>
   <PRE>void <B>discard</B>()</PRE>
   
      <UL>Deletes event handlers, control widgets, templates and references to the
 object to let JavaScript garbage collector to delete the object.

 <pre>
 Calls <a href="../Zapatec/Widget.html#discardEventHandlers">Zapatec.Widget.discardEventHandlers()</a>,
 <a href="../Zapatec/Widget.html#discardControls">Zapatec.Widget.discardControls()</a>,
 <a href="../Zapatec/Widget.html#discardTemplates">Zapatec.Widget.discardTemplates()</a>.
 Deletes a reference to the object from the internal list.
 Calls <a href="../Zapatec/Widget.html#removeCircularRefs">Zapatec.Widget.removeCircularRefs()</a>.
 This lets JavaScript garbage collector to delete an object unless there are
 any external references to it.

 Id of discarded object is reused. When you create a new instance of the
 Widget, it obtains id of previously discarded object.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="discardControls"><!-- --></A>
   <H3>discardControls</H3>
   <PRE>void <B>discardControls</B>()</PRE>
   
      <UL>Deletes widgets created in <a href="../Zapatec/Widget.html#initControls">Zapatec.Widget.initControls()</a>.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="discardEventHandlers"><!-- --></A>
   <H3>discardEventHandlers</H3>
   <PRE>void <B>discardEventHandlers</B>()</PRE>
   
      <UL>Deletes event handlers set in <a href="../Zapatec/Widget.html#setEventHandlers">Zapatec.Widget.setEventHandlers()</a>.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="discardTemplates"><!-- --></A>
   <H3>discardTemplates</H3>
   <PRE>void <B>discardTemplates</B>()</PRE>
   
      <UL>Deletes templates created in <a href="../Zapatec/Widget.html#initTemplates">Zapatec.Widget.initTemplates()</a>.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="display"><!-- --></A>
   <H3>display</H3>
   <PRE>void <B>display</B>()</PRE>
   
      <UL>Must compile main template and display result. Called during initialization.
 Extend this in child class unless your widget must not be displayed during
 initialization.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="formElementId"><!-- --></A>
   <H3>formElementId</H3>
   <PRE>string <B>formElementId</B>(oArg)</PRE>
   
      <UL>Forms unique element id from widget id, unique counter and provided prefix
 and suffix.

 <pre>
 Arguments object format:
 {
   prefix: [string, optional] prefix, default: 'zpWidget',
   suffix: [string, optional] suffix, default: '-'
 }
 E.g. if widget id is 0, unique counter is 1 and following object provided
 {
   prefix: 'zpWidget',
   suffix: 'Item'
 },
 id will be 'zpWidget0Item1'.

 Defines internal property <b>widgetUniqueIdCounter</b>.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  [object] Arguments object  
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Element id   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="getClassName"><!-- --></A>
   <H3>getClassName</H3>
   <PRE>string <B>getClassName</B>(oArg)</PRE>
   
      <UL>Forms class name from theme name and provided prefix and suffix.

 <pre>
 Arguments object format:
 {
   prefix: [string, optional] prefix,
   suffix: [string, optional] suffix
 }
 E.g. if this.config.theme == 'default' and following object provided
 {
   prefix: 'zpWidget',
   suffix: 'Container'
 },
 class name will be 'zpWidgetDefaultContainer'.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  [object] Arguments object  
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Class name   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="getConfiguration"><!-- --></A>
   <H3>getConfiguration</H3>
   <PRE>object <B>getConfiguration</B>()</PRE>
   
      <UL>Returns current configuration of the widget.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Current configuration   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="getMessage"><!-- --></A>
   <H3>getMessage</H3>
   <PRE>Object <B>getMessage</B>(key)</PRE>
   
      <UL>Get message for given key, make substitutions and return.
 If more then 1 argument given - method will replace %1, .. %N with corresponding argument value</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>key</CODE> -  {Object} String, object or anything else that can be treated as array key in Javascript. Required.  
      </UL> 
   
     <UL><CODE>substitution1</CODE> -  {String} First substitution to the string. Optional.  ...  
      </UL> 
   
     <UL><CODE>substitutionN</CODE> -  {String} Last substitution to the string. Optional.
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="hideContainer"><!-- --></A>
   <H3>hideContainer</H3>
   <PRE>Object <B>hideContainer</B>(&lt;object&gt; effects, &lt;number&gt; animSpeed, onFinish)</PRE>
   
      <UL>Hides widget using given effects and animation speed. You need to define
 this.container to use this method.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>effects</CODE> -  list of effects to apply  
      </UL> 
   
     <UL><CODE>animSpeed</CODE> -  possible values - 1..100. Bigger value - more fast animation.
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="init"><!-- --></A>
   <H3>init</H3>
   <PRE>void <B>init</B>(&lt;object&gt; oArg)</PRE>
   
      <UL>Initializes object.

 <pre>
 Important: Before calling this method, define config options for the widget.
 Initially "this.config" object should contain all config options with their
 default values. Then values of config options will be changed with user
 configuration in this method. Config options provided by user that were not
 found in "this.config" object will be ignored.

 Defines internal property <b>id</b>.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  User configuration    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="initControls"><!-- --></A>
   <H3>initControls</H3>
   <PRE>void <B>initControls</B>()</PRE>
   
      <UL>Must initialize control widgets. Control widget is a widget initialized and
 used inside current widget for different purposes, e.g. to display dialog.
 Deletes all existing control widgets and creates new control widgets.
 Extend this in child class.

 <pre>
 Defines internal property <b>controls</b>, which gives ability to access
 each control widget object using its name. Example: this.controls.dialog.

 All widget objects containing in the <b>controls</b> property are deleted
 automatically in <a href="../Zapatec/Widget.html#discardControls">Zapatec.Widget.discardControls()</a> and
 <a href="../Zapatec/Widget.html#discard">Zapatec.Widget.discard()</a> methods.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="initTemplates"><!-- --></A>
   <H3>initTemplates</H3>
   <PRE>void <B>initTemplates</B>()</PRE>
   
      <UL>Initializes templates. Requires Zapatec.Template. Deletes all existing
 templates and creates new Zapatec.Template objects from the
 <b>templates</b> config option.

 <pre>
 Defines internal property <b>templates</b>, which gives ability to access
 each template object using its name. Example: this.templates.main.

 All template objects containing in the <b>templates</b> property are deleted
 automatically in <a href="../Zapatec/Widget.html#discardTemplates">Zapatec.Widget.discardTemplates()</a> and
 <a href="../Zapatec/Widget.html#discard">Zapatec.Widget.discard()</a> methods.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <UL>   
   <B>Requires:</B><UL>- Zapatec.Template Requires zptemplate/src/zptemplate.js</UL>
   </UL>
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadData"><!-- --></A>
   <H3>loadData</H3>
   <PRE>void <B>loadData</B>(&lt;object&gt; oArg)</PRE>
   
      <UL>Loads data from the specified source.

 <pre>
 If source is URL, fires events:
 <ul>
 <li><i>fetchSourceStart</i> before fetching of source</li>
 <li><i>fetchSourceError</i> if fetch failed. Passes one argument to the
 listener: error object received from Zapatec.Transport#fetch.</li>
 <li><i>fetchSourceEnd</i> after source is fetched or fetch failed</li>
 </ul>

 Fires events:
 <ul>
 <li><i>loadDataStart</i> before parsing of data</li>
 <li><i>loadDataEnd</i> after data are parsed or error occured during
 fetch</li>
 </ul>

 <i>fetchSourceError</i> is fired before <i>fetchSourceEnd</i> and
 <i>loadDataEnd</i>.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  Arguments object passed to callbackSource function    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadDataAbort"><!-- --></A>
   <H3>loadDataAbort</H3>
   <PRE>void <B>loadDataAbort</B>()</PRE>
   
      <UL>Aborts data load from server.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadDataHtml"><!-- --></A>
   <H3>loadDataHtml</H3>
   <PRE>void <B>loadDataHtml</B>(&lt;object&gt; oSource)</PRE>
   
      <UL>Loads data from the HTML source. Override this in child class.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oSource</CODE> -  Source HTMLElement object    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadDataHtmlText"><!-- --></A>
   <H3>loadDataHtmlText</H3>
   <PRE>void <B>loadDataHtmlText</B>(&lt;string&gt; sSource)</PRE>
   
      <UL>Loads data from the HTML fragment source.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>sSource</CODE> -  Source HTML fragment    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadDataJson"><!-- --></A>
   <H3>loadDataJson</H3>
   <PRE>void <B>loadDataJson</B>(&lt;object&gt; oSource)</PRE>
   
      <UL>Loads data from the JSON source. Override this in child class.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oSource</CODE> -  Source JSON object    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadDataXml"><!-- --></A>
   <H3>loadDataXml</H3>
   <PRE>void <B>loadDataXml</B>(&lt;object&gt; oSource)</PRE>
   
      <UL>Loads data from the XML source. Override this in child class.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oSource</CODE> -  Source XMLDocument object    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadTemplate"><!-- --></A>
   <H3>loadTemplate</H3>
   <PRE>void <B>loadTemplate</B>()</PRE>
   
      <UL>Loads specified template file.

 <pre>
 Fires events:
 <ul>
 <li><i>loadTemplateStart</i> before template loading starts</li>
 <li><i>loadTemplateEnd</i> after template file was loaded or template loading
 has failed</li>
 <li><i>loadTemplateError</i> after template loading has failed. Passes one
 argument to the listener: error object received from
 Zapatec.Transport#fetch.</li>
 </ul>

 Once template file is loaded, converts templates into DOM objects, calls
 <a href="../Zapatec/Widget.html#initTemplates">Zapatec.Widget.initTemplates()</a> and then <a href="../Zapatec/Widget.html#display">Zapatec.Widget.display()</a>.

 Defines internal property <b>templateLoaded</b>.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="loadTheme"><!-- --></A>
   <H3>loadTheme</H3>
   <PRE>void <B>loadTheme</B>()</PRE>
   
      <UL>Loads specified theme.

 <pre>
 Fires events:
 <ul>
 <li><i>loadThemeStart</i> before theme loading starts</li>
 <li><i>loadThemeEnd</i> after theme was loaded or theme loading has failed</li>
 <li><i>loadThemeError</i> after theme loading has failed. Passes one argument
 to the listener: error object received from
 Zapatec.Transport#loadCss.</li>
 </ul>

 If special zapatecDoNotLoadThemes flag is set, this function does not load
 theme CSS file. Theme CSS file must be included manually.

 Defines internal property <b>themeLoaded</b>.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="receiveData"><!-- --></A>
   <H3>receiveData</H3>
   <PRE>void <B>receiveData</B>(&lt;object&gt; oArg)</PRE>
   
      <UL>Loads data passed from other widget for example to view or edit them. Extend
 this in child class.

 <pre>
 Argument object format:
 {
   widget: [object] Optional. Sender widget instance,
   data: [any] Data in format specific for each widget
 }

 Saves passed widget in private property <i>dataSender</i> for later use in
 <a href="../Zapatec/Widget.html#replyDataReturn">Zapatec.Widget.replyDataReturn()</a>.

 Fires event:
 <ul>
 <li><i>receiveData</i>. Listener receives argument object passed to this
 method.</li>
 </ul>
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  Argument object    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="reconfigure"><!-- --></A>
   <H3>reconfigure</H3>
   <PRE>void <B>reconfigure</B>(&lt;object&gt; oArg)</PRE>
   
      <UL>Reconfigures the widget with new config options after it was initialized.
 May be used to change look or behavior of the widget after it has loaded
 the data. In the argument pass only values for changed config options.
 There is no need to pass config options that were not changed.

 <pre>
 Note: "eventListeners" config option is ignored by this method because it is
 useful only on initialization. To add event listener after the widget was
 initialized, use addEventListener method instead.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  Optional. Changes to user configuration    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="removeEventHandler"><!-- --></A>
   <H3>removeEventHandler</H3>
   <PRE>void <B>removeEventHandler</B>(&lt;string&gt; sHandlerName)</PRE>
   
      <UL>Removes existing DOM event.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>sHandlerName</CODE> -  Unique handler name    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="replyData"><!-- --></A>
   <H3>replyData</H3>
   <PRE>any <B>replyData</B>()</PRE>
   
      <UL>Prepares processed data to return them back to the sender in the same format
 as they were received in <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a>. Extend this in
 child class.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Processed data in format specific for each widget.   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="replyDataCancel"><!-- --></A>
   <H3>replyDataCancel</H3>
   <PRE>void <B>replyDataCancel</B>()</PRE>
   
      <UL>Cancels processing of the data received from the sender in
 <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a>. Ususally just hides the widget (calls
 hide method of the widget if it is defined).

 <pre>
 Removes private property <i>dataSender</i>.

 Fires event:
 <ul>
 <li><i>replyDataCancel</i> before the widget is hidden</li>
 </ul>
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="replyDataReturn"><!-- --></A>
   <H3>replyDataReturn</H3>
   <PRE>void <B>replyDataReturn</B>(&lt;object&gt; oArg)</PRE>
   
      <UL>Returns processed data back to the specified widget (not necessarily to the
 same widget from which they were received in
 <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a>). Passes data to
 <a href="../Zapatec/Widget.html#acceptData">Zapatec.Widget.acceptData()</a> method of that widget. Then calls
 <a href="../Zapatec/Widget.html#replyDataCancel">Zapatec.Widget.replyDataCancel()</a> to hide this widget.

 <pre>
 Argument object format:
 {
   widget: [object] Optional. Receiver widget instance
 }

 If receiver widget was not specified, uses widget passed to
 <a href="../Zapatec/Widget.html#receiveData">Zapatec.Widget.receiveData()</a> and saved in private property
 <i>dataSender</i>.

 Fires event:
 <ul>
 <li><i>replyDataReturn</i> before passing data to the specified widget.
 Listener receives argument object passed to this method.</li>
 </ul>
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>oArg</CODE> -  Argument object    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="reset"><!-- --></A>
   <H3>reset</H3>
   <PRE>void <B>reset</B>()</PRE>
   
      <UL>Reconfigures the widget with original config options. May be used to reset
 configuration to defaults if the widget provides means to configure it by end
 user.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="setEventHandlers"><!-- --></A>
   <H3>setEventHandlers</H3>
   <PRE>void <B>setEventHandlers</B>()</PRE>
   
      <UL>Must set event handlers. Deletes all existing event handlers and sets new
 event handlers. Extend this in child class.

 <pre>
 Defines internal property <b>eventHandlers</b>, which gives ability to access
 each event handler function. Example: this.eventHandlers.onclick.

 All event handlers containing in the <b>eventHandlers</b> property are
 deleted automatically in <a href="../Zapatec/Widget.html#discardEventHandlers">Zapatec.Widget.discardEventHandlers()</a> and
 <a href="../Zapatec/Widget.html#discard">Zapatec.Widget.discard()</a> methods.
 </pre></UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="showContainer"><!-- --></A>
   <H3>showContainer</H3>
   <PRE>Object <B>showContainer</B>(&lt;object&gt; effects, &lt;number&gt; animSpeed, &lt;function&gt; onFinish)</PRE>
   
      <UL>Shows widget using given effects and animation speed. You need to define
 this.container to use this method.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>effects</CODE> -  list of effects to apply  
      </UL> 
   
     <UL><CODE>animSpeed</CODE> -  possible values - 1..100. Bigger value - more fast animation.  
      </UL> 
   
     <UL><CODE>onFinish</CODE> -  Function to call on effect end.
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="showHideContainer"><!-- --></A>
   <H3>showHideContainer</H3>
   <PRE>Object <B>showHideContainer</B>(&lt;object&gt; effects, &lt;number&gt; animSpeed, onFinish, &lt;boolean&gt; show)</PRE>
   
      <UL>Show/hides widget using given effects and animation speed. You need to define
 this.container to use this method.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>effects</CODE> -  list of effects to apply  
      </UL> 
   
     <UL><CODE>animSpeed</CODE> -  possible values - 1..100. Bigger value - more fast animation.  
      </UL> 
   
     <UL><CODE>show</CODE> -  if true - show widget. Otherwise - hide.
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="!s!callMethod"><!-- --></A>
   <H3>callMethod</H3>
   <PRE>&lt;static&gt; any <B>callMethod</B>(&lt;number&gt; iWidgetId, &lt;string&gt; sMethod)</PRE>
   
      <UL>Finds a widget by id and calls specified method with specified arguments and
 returns value from that method.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>iWidgetId</CODE> -  Widget id  
      </UL> 
   
     <UL><CODE>sMethod</CODE> -  Method name  
      </UL> 
   
     <UL><CODE>any</CODE> -  Any number of arguments  
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Value returned from the method   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="!s!debug"><!-- --></A>
   <H3>debug</H3>
   <PRE>&lt;static&gt; void <B>debug</B>(&lt;string&gt; sMsg, &lt;string&gt; sType)</PRE>
   
      <UL>Displays debug information.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>sMsg</CODE> -  Debug message  
      </UL> 
   
     <UL><CODE>sType</CODE> -  Optional. 'error' (default) or 'warn'    
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="!s!getElementById"><!-- --></A>
   <H3>getElementById</H3>
   <PRE>&lt;static&gt; object <B>getElementById</B>(&lt;string&gt; element)</PRE>
   
      <UL>Converts element id to reference.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>element</CODE> -  Element id  
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Reference to element   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="!s!getStyle"><!-- --></A>
   <H3>getStyle</H3>
   <PRE>&lt;static&gt; string <B>getStyle</B>(&lt;object&gt; element)</PRE>
   
      <UL>Returns style attribute of the specified element.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>element</CODE> -  Element  
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Style attribute value   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>

   <A NAME="!s!getWidgetById"><!-- --></A>
   <H3>getWidgetById</H3>
   <PRE>&lt;static&gt; object <B>getWidgetById</B>(iId)</PRE>
   
      <UL>Finds a widget by id.</UL>
   

   <!-- METHOD PARAMETERS START -->
   
   <UL>
   <B>Parameters:</B>
   
     <UL><CODE>Widget</CODE> -  id  
      </UL> 
   
   </UL>
   
   <!-- METHOD PARAMETERS END -->

   
   <UL>
   <B>Returns:</B>
        <UL>
        Widget or undefined if not found   
        </UL>
   </UL>
   

   <!-- ADDITIONAL ATTRIBUTES START -->
   
   <!-- ADDITIONAL ATTRIBUTES  END -->
<HR>



<!-- ============ METHOD DETAIL END ========== -->

<!-- ========= END OF CLASS DATA ========= -->

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="../overview-summary-zpwidget.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A>&nbsp;</TD>
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Zapatec Utils</B>
</EM>
</TD
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../Zapatec/Utils/Sizable.html"><B>PREV CLASS</B></A><!-- 
   NEXT CLASS 
-->
&nbsp;<A HREF="../Zapatec/Wizard.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>

<!-- =========== END OF NAVBAR =========== -->

<HR>
<FONT SIZE="-1">

</FONT>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Thu May 21 12:19:24 2009</div>
</BODY>
</HTML>
